<HTML><HEAD><TITLE>file_result(+File)</TITLE>
</HEAD><BODY>[ <A HREF="index.html">library(instrument)</A> | <A HREF="../../index.html">Reference Manual</A> | <A HREF="../../fullindex.html">Alphabetic Index</A> ]
<H1>file_result(+File)</H1>
Pretty-print a file, including any instrumentation results
<DL>
<DT><EM>File</EM></DT>
<DD>Atom or string
</DD>
</DL>
<H2>Description</H2>
<P>
   This will pretty-print the specified source file in the calling 
   module context, annotated with the result of instrumentation. 
   The resulting .html file is placed in a sub-directory called 
   instrument', relative to File.
   </P><P>
   See <TT>file_result/2</TT> for options to modify the output.
   </P><P>
   The use of this predicate is only meaningful if the module has 
   previously been instrumented and compiled 
   using <TT>instrument:instrument/1,2</TT>, and the code has been 
   run in order to obtain instrumentation results.
   </P><P>
   See <TT>struct(itemplate)</TT> for documentation of how the 
   result instrumentation is used in the annotation and pretty-printing 
   of the code.
   </P><P>
   The predicate is a tool and the instrumentation results of a 
   file in an alternate module to the current calling module context 
   can be obtained invoking <TT>file_result(File)@Module</TT>.
   <P>
<H3>Modules</H3>
This predicate is sensitive to its module context (tool predicate, see @/2).
<H2>See Also</H2>
<A HREF="../../lib/instrument/instrument-2.html">instrument / 2</A>, <A HREF="../../lib/instrument/instrument-3.html">instrument / 3</A>, <A HREF="../../lib/instrument/file_result-2.html">file_result / 2</A>, <A HREF="../../lib/instrument/index.html">library(instrument)</A>, <A HREF="../../lib/pretty_printer/index.html">library(pretty_printer)</A>, <A HREF="../../lib/instrument/module_result-0.html">module_result / 0</A>, <A HREF="../../lib/instrument/module_result-1.html">module_result / 1</A>, <A HREF="../../lib/instrument/itemplate-s.html">struct(itemplate)</A>, <A HREF="../../lib/instrument/defined_modules-2.html">defined_modules / 2</A>
</BODY></HTML>
